home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / games1 / splittim.lha / SplitTime.doc < prev    next >
Text File  |  1996-01-30  |  14KB  |  360 lines
  1.  
  2.                            SplitTime v1.4
  3.  
  4.                                  by
  5.  
  6.                               Rene Smit
  7.  
  8.                              30 Jan 1996
  9.  
  10.  
  11. This document describes SplitTime, a public domain utility which gives you
  12. three split times during your laps in World Circuit/Formula One Grandprix.
  13.  
  14. If you have any comments, buglists or suggestions feel free to mail me:
  15.  
  16. E-Mail:
  17.  
  18.         R.Smit@twi.tudelft.nl
  19.  
  20. WWW:
  21.         http://dutian.twi.tudelft/~smit/sdihome.html
  22.  
  23. Snail Mail:
  24.  
  25.         Rene Smit
  26.         Wenckebachstraat 42
  27.         2522 CL  The Hague
  28.         The Netherlands
  29.  
  30.  
  31.  
  32. Disclaimer
  33. ----------
  34. I hereby state that I am not responsible for any damage or loss of
  35. data, whether or not caused by using either SplitTime or PrintSplits.
  36.  
  37.  
  38.  
  39. Distribution
  40. ------------
  41. You may copy SplitTime to everyone as long as you copy the original
  42. lha file containing the following files:
  43.  
  44. - SplitTime        (c) 1995 Rene Smit
  45. - SplitTime.doc
  46. - PrintSplits        (c) 1995 Rene Smit
  47. - libs/f1gp.library    (c) 1995 Oliver Roberts
  48.  
  49. The f1gp.library was made by Oliver Roberts. The version of the library
  50. included here is 35.1.
  51.  
  52.  
  53.  
  54. What's new?
  55. -----------
  56. Version 1.3 is a special "F1GP Accessoires disk" version, released in
  57. December 1995. Version 1.4 is the same except for some minor changes,
  58. like a friendlier way of sending signals, which are not noticable by the
  59. user.
  60.  
  61. Added in v1.3/v1.4:
  62. - Autosave option.
  63. - Fixed a bug that caused problems with KS1.3 users. It looked like there
  64.   was another bug being introduced, causing problems for KS1.3 users again.
  65.   I'm still not sure if it has disappeared, but if SplitTime (still) doesn't
  66.   work for you, please email me.
  67. - Safer way of displaying split times.
  68. - Added split times in race.
  69. - Changed the virtual lap time row to a virtual times column.
  70. - Added a light on the dashboard that indicates if a split is improved.
  71.  
  72.  
  73. What is SplitTime?
  74. ------------------
  75. SplitTime is a utility that displays split times at every quarter of a
  76. track while you drive F1GP (so you need that game to use it). Not only
  77. the splittimes are displayed, but also the best splittimes before they
  78. show up (like on TV). Note that I use 3 split times on every track and
  79. that they are exactly at 25%, 50% and 75%, while on TV they now use
  80. only 2 split times (intermediates) at specific points on the track.
  81.  
  82.  
  83. Why do I need it?
  84. -----------------
  85. This utility let's you know how well you're on your way while driving a
  86. lap, so you don't have to drive the whole lap before knowing if you drove
  87. well. Normally, you have your own physical markers and locations at which
  88. you look at the timer to know how fast you're on your way, but now you can
  89. forget those and use these very accurate splittimes instead. If you finish
  90. a lap and forget the split times you drove, don't worry, they can be
  91. viewed in the SplitTime window, as well as some other info.
  92.  
  93.  
  94. Is this all?
  95. ------------
  96. No, this is not all. Besides showing (best) splittimes it also keeps track
  97. of the best split differences, calculated by looking at the time between
  98. two consecutive splittimes. The four best differences are always remembered
  99. and from these, virtual split times are calculated, which means that you are
  100. able to see what time you could have driven if you had done a perfect lap.
  101.  
  102. All times can be saved to disk so nothing will be lost. This means that
  103. once you have improved a splittime you will see it on your display from
  104. then on every time you are gonna play f1gp again. The car number is saved
  105. with each split difference, so if more people are driving with the same
  106. datafile and they use different car numbers, you can see to whom each split
  107. difference belongs. Also, the lap in which it was driven is stored so you
  108. can see in which lap you drive a certain part best and determine how you
  109. can best warm up your tyres. Note that f1gp does not reset the lap number
  110. to 1 if you drive into your pit position in qualify, instead of pressing
  111. 'q'.
  112.  
  113.  
  114. What do I require?
  115. ------------------
  116. - Any Amiga. People using kickstart 1.x will miss the commandline options,
  117.   and will have default options.
  118. - F1GP by Microprose, any version (European F1GP, World Circuit or the
  119.   A600 WWW version).
  120. - Oliver Roberts' f1gp.library, necessary for SplitTime to work.
  121.   f1gp.library is included with SplitTime in the directory 'libs'. You need
  122.   to copy the library to your libs: directory. If you already have one from
  123.   the latest f1gp-ed, you don't need to do that as the f1gp.library supplied
  124.   with f1gp-ed is always the same or newer as the one included here.
  125.  
  126.  
  127. How do I start it?
  128. ------------------
  129. Start this program after f1gp is run and it shows 'please wait', from cli
  130. or workbench (although SplitTime doesn't support tooltypes yet).
  131. It is also possible to run it without f1gp, in which case only the times
  132. can be viewed, but it's better to use PrintSplits for that (see below).
  133.  
  134. For the options you need to start SplitTime from the cli with the following
  135. synopsis:
  136.  
  137.   SplitTime NAME,DELAY/N,AU=AUTOUPDATE/S,AS=AUTOSAVE/S,NORACE/S,NOLIGHT/S,
  138.             QUIT/S,LEFT/N,TOP/N,QUIET/S
  139.  
  140. This is what each option does (KS 2.0+ only; to KS 1.x users it will
  141. appear as none of these options are specified, except for the QUIT option):
  142.  
  143. NAME
  144.     Specify filename for the datafile. If not specified, the filename
  145.     s:SplitTime.dat will be used. If the file does not exist, it will
  146.     be created when the data is saved from within the program.
  147.     Old versions will be converted.
  148.  
  149. DELAY/N
  150.     Display suspend delay, the time that the (split)time is shown on
  151.     the dashboard before it's replace by the clock again. Default 5
  152.     seconds (the game originally uses 10 secs for the laptime). It may
  153.     not be negative or more than 10 seconds.
  154.  
  155. AUTOUPDATE/S
  156.     If specified, SplitTime wil automatically update the window contents
  157.     if an improvement has been made while you were driving.
  158.  
  159. AUTOSAVE/S
  160.     If specified, SplitTime wil automatically save the split times.
  161.     This option will enable the AUTOUPDATE option, and will save the
  162.     times at the same moment as the automatic update occurs.
  163.  
  164. NORACE/S
  165.     Will disable split times in the race.
  166.  
  167. NORACE/S
  168.     Will disable the little light that indicates a split improvement.
  169.  
  170. QUIT/S
  171.     If specified, SplitTime will automatically quit if f1gp quits. The
  172.     data will be saved before it does so. Kickstart 1.x users will have
  173.     this enabled.
  174.  
  175. LEFT/N
  176.     Specify left offset for window.
  177.  
  178. TOP/N
  179.     Specify top offset for window.
  180.  
  181. QUIET/S
  182.     Tell SplitTime to shut up.
  183.  
  184.  
  185.  
  186. How do I use it?
  187. ----------------
  188. When f1gp is found, a window is opened. The window will be full of '-:--.---'
  189. lines when you start it, but after driving a lap they will already be filled
  190. with times. At the top is a line that tells you the name of the currently
  191. selected track ('not selected' at first). The bottom line will give you some
  192. info about what's going on. In between there is the real data. There are
  193. seven columns: Spl, Car, Lap, BestDiff, VirtTime, BestTime and LastTime.
  194.  
  195. The 'Spl' column contains the split number for each row. There are four
  196. rows (1/4 ... 4/4).
  197.  
  198. The 'Car' and 'Lap' columns contain the car number and lap number in which
  199. each best split difference is done. The lap is always 2 or higher in non-race
  200. sessions since the first lap is a warm-up lap. For the race the lap will be
  201. 1 or higher.
  202.  
  203. The 'BestDiff' column shows you the best split difference, i.e. it shows how
  204. much time it took to drive the corresponding quarter of the track, and this
  205. only gets updated when it's improved.
  206.  
  207. The 'VirtTime' column is derived from the 'BestDiff' column and shows the
  208. virtual split times you could have driven if the best split differences had
  209. been done in one go. The 4th one is your virtual laptime (this one was shown
  210. in previous versions).
  211.  
  212. The 'BestTime' column contains the best split time at each quarter of the
  213. track. The one at the bottom will match your best laptime, and for this one
  214. additional info is being stored (although not shown) like the setup, traction
  215. control on or off, and more. This info can be viewed with the external
  216. split data viewer PrintSplits (use the VERBOSE option).
  217.  
  218. The column most to the right, 'LastTime', contains the split times that have
  219. been driven the last time. Once you cross the first split with your car they
  220. will be cleared again.
  221.  
  222. As you drive laps and switch back to the workbench to look at the SplitTime
  223. window, you can click the mouse button in the window or press <return>
  224. while it is selected to get an update of your times. If the AUTOUPDATE option
  225. was specified, the times will be updated automatically and the workbench
  226. screen will be brought to front to let you watch them. You'll see that the
  227. improved times will be highlighted in order to help you notice where you
  228. drove better than the previous time.
  229. Note that the autoupdate updates the times when the system is enabled, i.e
  230. after you press <esc>, so only times that have been updated since the last
  231. time you left cockpit will be highlighted. If the AUTOSAVE option was
  232. specified the times will be saved as well (look out, you cannot revert
  233. the data anymore).
  234.  
  235. Besides this, you can be kept up to date of your performance while you're
  236. driving too. A little light on the right (above the 'player' light), will
  237. have a certain colour after each split. If you improve a split time but
  238. not a split diff, it will be grey. If you improve a split diff but not a
  239. split time it will be dark yellow. If you improve both the split time and
  240. split diff it will be light yellow. Else it will be off (black). If you
  241. find this light distracting you can turn it off with the NOLIGHT option.
  242.  
  243. The window doesn't have any buttons, but every command can be given by
  244. pressing a key while the window is activated. For normal use you don't even
  245. have to touch a key, as clicking the mousebutton on the window will select
  246. the track that you just drove on (if you did so) and will update all the
  247. times. The times are saved automatically when f1gp quits and the QUIT option
  248. has been specified when you started SplitTime. If you didn't, then the times
  249. can only be saved with the 's' key or have them saved automatically when
  250. you quit by pressing the <escape> key. There are no filerequesters, but the
  251. data will be saved to s:SplitTime.dat or to the file that was specified
  252. on the commandline. The same goes for the 'load' command ('l' key).
  253. If you want to quit but don't want to save the data you can use the close
  254. button of the window, or use ctrl-c in the shell you started SplitTime from.
  255.  
  256. Here is the list of keystrokes:
  257.  
  258. 1..9a..g    select a track:
  259.         1=Phoenix, 2=Interlagos, ..., g=Adelaide.
  260. crsr up        select first track (Phoenix).
  261. crsr down    select last track (Adelaide).
  262. crsr left    select previous track.
  263. crsr right    select next track.
  264. 's'        save all data to disk.
  265. 'l'        load all data (no questions asked!).
  266. <return>    update display (or click the mousebutton in the window).
  267. <del>        clear all times of currently selected track (you will be
  268.         asked for confirmation, press 'y' to confirm).
  269. F1-F4        will erase the corresponding split difference.
  270. F6-F9        same as F1-F4, but will erase a split time.
  271. <esc>        save (if something has changed) all data and quit.
  272.  
  273.  
  274. Kickstart 1.x users won't be able to use the cursor keys or the function
  275. keys due to a system bug.
  276.  
  277.  
  278. What about my old datafile?
  279. ---------------------------
  280. If you have used SplitTime v1.0 before this one you have probably a datafile
  281. for it. SplitTime v1.3 can load the old datafile, but it won't have the new
  282. data I added (setup and stuff). If you save it again, it will be converted
  283. to a new datafile.
  284. The datafile format hasn't changed anymore since v1.1.
  285.  
  286.  
  287. How do I print the data?
  288. ------------------------
  289. I have made an external print program named PrintSplits which will print
  290. your data to standard output (use the redirection option or the copy to
  291. clipboard option of the shell to get it into a file).
  292.  
  293. Usage:
  294.  
  295. PrintSplits NAME/K,TRACK/N,VERBOSE/S,LIST/S
  296.  
  297. NAME/K
  298.     Name of the datafile. You have to specify the keyword NAME, else
  299.     ReadArgs thinks it's the track number :)
  300.     If not specified, "s:SplitTime.dat" will be tried.
  301.  
  302. TRACK/N
  303.     Track number of which you want to print the data.
  304.     If not specified, data of all tracks will be printed.
  305.  
  306. VERBOSE/S
  307.     If specified, some extra information will be printed like the
  308.     setup and horsepower used for the best lap (4th best split time).
  309.     It will also print if traction control was on or off.
  310.  
  311. LIST/S
  312.     If specified, only a list of all the tracks with each track
  313.     number will be printed, so you can see what number to specify
  314.     for a track.
  315.  
  316.  
  317.  
  318. Some notes about using SplitTime
  319. --------------------------------
  320. Sometimes the split time is clocked in the middle of a corner. This can
  321. be annoying since the time then depends on the moment you brake for the
  322. corner. For example, if you brake too late into the corner, the split time
  323. will be good, but the next split time will probably be a bad one since
  324. you exit the badly taken corner with lower speed. Such split times mess
  325. up the virtual record a bit in a way that it tells you that you can drive
  326. a certain time, but that it's not the case in reality.
  327. Of course it's possible for me to change the locations at which the splits
  328. are clocked, but I wanted to keep them this way because then they would
  329. be the same as on the pc. I may have changed it though in a next version.
  330. Whenever you mess up a split time or difference like this, you are able
  331. to clear each individual difference with keys F1 to F4, and each split time
  332. with keys F5 to F9 (not with kickstart 1.x). Or clear everything in one go
  333. with the <del> key.
  334.  
  335. When driving with different setups, frame frates or other configurations,
  336. the virtual times can be affected also. It is advised to use a different
  337. datafile for each configuration so you can always compare the virtual
  338. record or individual split times/differences.
  339.  
  340. It is better _not_ to quit and/or (re)start SplitTime in the middle of a
  341. session. Although nothing serious can go wrong it is possible that the
  342. best laptime the game keeps track of will be erased by SplitTime, or
  343. the other way round.
  344.  
  345.  
  346.  
  347. People I want to thank
  348. ----------------------
  349.  
  350. Thanks go to:
  351.  
  352. - Grant Reeve for helping me and beta-testing.
  353. - Oliver Roberts for beta-testing and support.
  354. - Dave Wright for testing with kickstart 1.3.
  355. - Edo Nijmeijer, Maarten van Schouwen, Patrick Giesbergen and
  356.   Robert Schaftlein, also for beta-testing.
  357. - Trevor Kellaway, who also made SPLITTIM on the pc which gave
  358.   me the idea to code it for the Amiga.
  359. - All the people who gave me feedback!
  360.